Skip to content

docs: add TypeScript vended tools documentation#685

Merged
zastrowm merged 4 commits intomainfrom
agent-tasks/671
Mar 27, 2026
Merged

docs: add TypeScript vended tools documentation#685
zastrowm merged 4 commits intomainfrom
agent-tasks/671

Conversation

@zastrowm
Copy link
Copy Markdown
Member

@zastrowm zastrowm commented Mar 19, 2026

Description

Adds a new "Vended Tools" documentation page for the TypeScript SDK covering the four built-in tools shipped with @strands-agents/sdk: bash, fileEditor, httpRequest, and notebook.

The page covers:

  • Quick start with import paths and basic agent setup
  • Per-tool descriptions with usage examples and security callouts where relevant
  • A combined multi-tool workflow example
  • A comparison table against the Python community tools package (consent model, tool count, platform support)
  • Versioning and maintenance expectations

Related Issues

Closes #671

Type of Change

  • New content

Checklist

  • I have read the CONTRIBUTING document
  • My changes follow the project's documentation style
  • I have tested the documentation locally using npm run dev
  • Links in the documentation are valid and working

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@github-actions

This comment was marked as outdated.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 19, 2026

Documentation Preview Ready

Your documentation preview has been successfully deployed!

Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-685/docs/user-guide/quickstart/overview/

Updated at: 2026-03-27T14:01:26.163Z

@zastrowm

This comment was marked as outdated.

@zastrowm

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

Add comprehensive documentation for TypeScript SDK vended tools:

- bash: Shell command execution with persistent sessions
- fileEditor: File viewing, creation, and editing
- httpRequest: HTTP requests to external APIs
- notebook: Persistent text notebooks

Includes:
- Security warnings and responsibility model documentation
- Code examples with TypeScript snippets
- Links to SDK READMEs for detailed API reference
- References to Interrupts/Hooks for consent workflows
- Navigation update to include page under Tools section
@github-actions

This comment was marked as outdated.

@github-actions

This comment was marked as outdated.

@zastrowm zastrowm added the agent label Mar 20, 2026
@zastrowm zastrowm marked this pull request as ready for review March 20, 2026 20:08
@zastrowm zastrowm enabled auto-merge (squash) March 20, 2026 20:15
@github-actions
Copy link
Copy Markdown
Contributor

Assessment: Approve ✅

Changes since last review look good:

  • "Differences from Community Tools" section removed - Agreed this was awkward for a TypeScript-only page. Good call.
  • Versioning section improved - Now clarifies that tool names are stable, while description/spec/parameters may change in minor versions.
Review Summary

Documentation Quality:

  • Clean, focused structure without unnecessary comparisons
  • Clear versioning expectations for developers
  • All essential content retained (tools, examples, security warnings, See also)

Open Threads:

  • Unshure's versioning question (tool version pinning) is a good feature idea but not blocking for this docs PR

Ready to merge! 🎉

@zastrowm zastrowm merged commit 0b64b59 into main Mar 27, 2026
9 checks passed
notowen333 pushed a commit to notowen333/docs that referenced this pull request Mar 27, 2026
Co-authored-by: Mackenzie Zastrow <zastrowm@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[NEW CONTENT] Document TypeScript vended tools and the related guidance

3 participants